/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#ifndef VTA_DPI_MODULE_H_
#define VTA_DPI_MODULE_H_

#include "runtime/module.h"
#include <condition_variable>
#include <mutex>
#include <queue>
#include <string>

namespace vta
{
namespace dpi
{

/*!
 * \brief DPI driver module for managing the accelerator
 */
class DPIModuleNode : public tvm::runtime::ModuleNode
{
public:
  /*! \brief Launch hardware simulation */
  virtual void SimLaunch() = 0;

  /*! \brief Halt hardware simulation */
  virtual void SimWait() = 0;

  /*! \brief Resume hardware simulation */
  virtual void SimResume() = 0;

  /*! \brief Finish hardware simulation */
  virtual void SimFinish() = 0;

  /*!
   * \brief Write an accelerator register
   * \param addr The register address
   * \param value The register value
   */
  virtual void WriteReg(int addr, uint32_t value) = 0;

  /*!
   * \brief Read an accelerator register
   * \param addr The register address
   */
  virtual uint32_t ReadReg(int addr) = 0;

  static tvm::runtime::Module Load(std::string dll_name);

  /*  void SaveToFile(const std::string &file_name, const std::string &format)
  {
    LOG(FATAL) << "Module[" << type_key() << "] does not support SaveToFile";
    return;
  };
  void SaveToBinary(dmlc::Stream *stream)
  {
    LOG(FATAL) << "Module[" << type_key() << "] does not support SaveToBinary";
    return;
  };

  std::string GetSource(const std::string &format)
  {
    LOG(FATAL) << "Module[" << type_key() << "] does not support GetSource";
    return "";
  }; */
};

} // namespace dpi
} // namespace vta
#endif // VTA_DPI_MODULE_H_
